---
layout: '@/layouts/DocsLayout.astro'
title: Table Export
description: Table Export extension of Bootstrap Table.
group: extensions
toc: true
---

Use Plugin: [tableExport.jquery.plugin](https://github.com/hhurz/tableExport.jquery.plugin)

This is an important link to check out as some file types may require extra steps.

## Usage

```html
<script src="extensions/export/bootstrap-table-export.js"></script>
```

## Example

[Export](https://examples.bootstrap-table.com/#extensions/export.html)

## Options

### showExport

- **Attribute:** `data-show-export`

- **type:** `Boolean`

- **Detail:**

  Set `true` to show the export button.

- **Default:** `false`

### exportDataType

- **Attribute:** `data-export-data-type`

- **type:** `String`

- **Detail:**

  Export data type, support: `'basic'`, `'all'`, `'selected'`.

- **Default:** `basic`

### exportFooter

- **Attribute:** `data-export-footer`

- **type:** `Boolean`

- **Detail:**

  Set `true` to export the table footer.

- **Default:** `false`

### exportOptions

- **Attribute:** `data-export-options`

- **type:** `Object`

- **Detail:**

  Export [options](https://github.com/hhurz/tableExport.jquery.plugin#options) of `tableExport.jquery.plugin`

  `exportOptions.fileName` can be a string or a function, for example:

  ```js
  exportOptions: {
    fileName: function () {
      return 'exportName'
    }
  }
  ```

### exportTypes

- **Attribute:** `data-export-types`

- **type:** `Array`

- **Detail:**

  Export types, support types: `['json', 'xml', 'png', 'csv', 'txt', 'sql', 'doc', 'excel', 'xlsx', 'pdf']`.

- **Default:** `['json', 'xml', 'csv', 'txt', 'sql', 'excel']`

### Icons

- export: `'glyphicon-export icon-share'`

## Column options

### forceExport

- **Attribute:** `data-force-export`

- **type:** `Boolean`

- **Detail:**

  Set `true` to force export a column e.g. hidden columns.

- **Default:** `false`

### forceHide

- **Attribute:** `data-force-hide`

- **type:** `Boolean`

- **Detail:**

  Set `true` to force hide a column e.g. for icon columns.

- **Default:** `false`

## Events

### onExportSaved

- **jQuery Event:** `export-saved.bs.table`

- **Parameter:** `exportedRows`

- **Detail:**

  Fired when the data is exported, the parameter contain:

  * `exportedRows`: The exported rows (depends on exportDataType)

### onExportStarted

- **jQuery Event:** `export-started.bs.table`

- **Parameter:** `undefined`

- **Detail:**

  Fired before the data will be collected and exported.

## Methods

### exportTable

- **parameters:** `options`

- **Detail:**

  Export table with custom options.

## Localizations

### formatExport

- **Parameter:** `undefined`

- **Default:** `function () { return "Export data" }`
